phidget21.phiddict

This file is part of libphidget21

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, see <http://www.gnu.org/licenses/>

Members

Aliases

CPhidgetDictionaryHandle alias CPhidgetDictionaryHandle = _CPhidgetDictionary*: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CPhidgetDictionaryListenerHandle alias CPhidgetDictionaryListenerHandle = _CPhidgetDictionaryListener*: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CPhidgetDictionary_OnKeyChange_Function alias CPhidgetDictionary_OnKeyChange_Function = int function(CPhidgetDictionaryHandle dict, void* userPtr, const char* key, const char* value, CPhidgetDictionary_keyChangeReason reason): Callback function for KeyChange events.
CPhidgetDictionary_set_OnError_Handler_Func alias CPhidgetDictionary_set_OnError_Handler_Func = int function(CPhidgetDictionaryHandle, void* userPtr, int errorCode, const char* errorString): Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CPhidgetDictionary_set_OnServerConnect_Handler_Func alias CPhidgetDictionary_set_OnServerConnect_Handler_Func = int function(CPhidgetDictionaryHandle dict, void* userPtr): Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CPhidgetDictionary_set_OnServerDisconnect_Handler_Func alias CPhidgetDictionary_set_OnServerDisconnect_Handler_Func = int function(CPhidgetDictionaryHandle dict, void* userPtr): Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

Enums

CPhidgetDictionary_keyChangeReason enum CPhidgetDictionary_keyChangeReason: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

Static variables

CPhidgetDictionary_addKey int function(CPhidgetDictionaryHandle dict, const char* key, const char* value, int persistent) CPhidgetDictionary_addKey;: Adds a key/value pair to the dictionary. Or, changes an existing key's value.
CPhidgetDictionary_close int function(CPhidgetDictionaryHandle dict) CPhidgetDictionary_close;: Closes the connection to a Phidget Dictionary.
CPhidgetDictionary_create int function(CPhidgetDictionaryHandle* dict) CPhidgetDictionary_create;: Creates a Phidget Dictionary handle.
CPhidgetDictionary_delete int function(CPhidgetDictionaryHandle dict) CPhidgetDictionary_delete;: Frees a Phidget Dictionary handle.
CPhidgetDictionary_getKey int function(CPhidgetDictionaryHandle dict, const char* key, char* value, int valuelen) CPhidgetDictionary_getKey;: Gets a key value. If more then one key matches, only the first value is returned.
CPhidgetDictionary_getServerAddress
int function(CPhidgetDictionaryHandle dict, const char** address, int* port) CPhidgetDictionary_getServerAddress;: Gets the address and port.
CPhidgetDictionary_getServerID
int function(CPhidgetDictionaryHandle dict, const char** serverID) CPhidgetDictionary_getServerID;: Gets the server ID.
CPhidgetDictionary_getServerStatus int function(CPhidgetDictionaryHandle dict, int* serverStatus) CPhidgetDictionary_getServerStatus;: Gets the connected to server status.
CPhidgetDictionary_openRemote int function(CPhidgetDictionaryHandle dict, const char* serverID, const char* password) CPhidgetDictionary_openRemote;: Opens a Phidget dictionary by ServerID. Note that this requires Bonjour (mDNS) to be running on both the host and the server.
CPhidgetDictionary_openRemoteIP int function(CPhidgetDictionaryHandle dict, const char* address, int port, const char* password) CPhidgetDictionary_openRemoteIP;: Opens a Phidget dictionary by address and port.
CPhidgetDictionary_removeKey int function(CPhidgetDictionaryHandle dict, const char* pattern) CPhidgetDictionary_removeKey;: Removes a set of keys from the dictionary.
CPhidgetDictionary_remove_OnKeyChange_Handler int function(CPhidgetDictionaryListenerHandle dictlistener) CPhidgetDictionary_remove_OnKeyChange_Handler;: Removes a key listener.
CPhidgetDictionary_set_OnError_Handler int function(CPhidgetDictionaryHandle dict, CPhidgetDictionary_set_OnError_Handler_Func fptr, void* userPtr) CPhidgetDictionary_set_OnError_Handler;: Sets the error handler callback function. This is called when an asyncrhonous error occurs.
CPhidgetDictionary_set_OnKeyChange_Handler int function(CPhidgetDictionaryHandle dict, CPhidgetDictionaryListenerHandle* dictlistener, const char* pattern, CPhidgetDictionary_OnKeyChange_Function fptr, void* userPtr) CPhidgetDictionary_set_OnKeyChange_Handler;: Adds a key listener to an opened dictionary. Note that this should only be called afrter the connection to the dictionary has been made - unlike all other events.
CPhidgetDictionary_set_OnServerConnect_Handler int function(CPhidgetDictionaryHandle dict, CPhidgetDictionary_set_OnServerConnect_Handler_Func fptr, void* userPtr) CPhidgetDictionary_set_OnServerConnect_Handler;: Sets a server connect handler callback function. This is called when a connection to the server has been made.
CPhidgetDictionary_set_OnServerDisconnect_Handler int function(CPhidgetDictionaryHandle dict, CPhidgetDictionary_set_OnServerDisconnect_Handler_Func fptr, void* userPtr) CPhidgetDictionary_set_OnServerDisconnect_Handler;: Sets a server disconnect handler callback function. This is called when a connection to the server has been lost.

Structs

_CPhidgetDictionary struct _CPhidgetDictionary: A Phidget Dictionary handle.
_CPhidgetDictionaryListener struct _CPhidgetDictionaryListener: A Dictionary key listener handle.